Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

OpenAIを活用したコードレビューボットの導入 #6

Merged
merged 1 commit into from
Jan 25, 2024

Conversation

yuminn-k
Copy link
Member

🔍 このPRで解決したい問題は何ですか?

実装した機能や解決した課題、PRを開くきっかけや目的をReviewerが理解しやすいように書いてください。
バックログのリンク、ダイアグラム、Figmaなどの関連ドキュメントを添付するとより良いです。

  • OpenAIを使用してコードレビュープロセスの効率を向上させたいと考えています。そのために新しいレビューシステムを導入します。このPRの目的は、OpenAIを活用したコードレビューシステムを実装することです。

✨ このPRで主に変わったことは何ですか?

問題を解決しながら、主な変更点を書いてください。

  • yamlファイルを作成してOpenAIをコードレビューに適用しました。これにより、コードレビューの効率が向上することを期待しています。

🔖 主な変更点以外に追加で変更された部分はありますか?

ない場合は「なし」と記載してください。

  • なし

🙏🏻 Reviewerに特に見ていただきたい部分はありますか?

開発過程で他の方の意見が気になったり、クロスチェックが必要だと感じたコードがあれば教えてください。

  • yamlファイルの構成に注目していただければと思います。特に runs-on, steps, uses, env, GITHUB_TOKEN, OPENAI_API_KEY などのフィールドについて詳しく見ていただければと思います。

🩺 このPRでテストや検証が必要な部分はありますか?

テストが必要な項目やテストコードが追加されたら一緒に書いてください。

  • このPRは新しいシステムを導入するものなので、実際にOpenAIがコードレビューに適用されるかどうかを確認するテストが必要です。

📚 関連するIssueやドキュメントのリンク

このPRが解決しようとしている問題に関連するIssueやドキュメントのリンクを記載してください。

🖥 作動する様子

スクリーンショットや録画したビデオ、またはgifを追加して、Reviewerが変更点を理解するのに役立ててください。

  • このPRはシステム設定を変更するものであり、作動する様子をスクリーンショットやビデオで示すことはできません。

📌 PRを行う際の注意点

  • Reviewerはコードレビュー時に良いコードの方向性を示しますが、コード修正を強制することはありません。
  • Reviewerは良いコードを見つけた場合、賞賛と励ましを惜しみません。
  • レビューは特別なケースでない限り、Reviewerに指定された時点から3日以内に行ってください。
  • コメント作成時にPrefixにP1、P2、P3を書いていただくと、Assigneeがより明確にコメントに対して対応することができます。
    • P1 : 必ず反映してください (Request Changes) - 問題が発生したり、脆弱性が発見されたケースなど。
    • P2 : 反映を積極的に検討していただければと思います (コメント)。
    • P3 : こんな方法もあるんじゃないかな~などの些細な意見です (Chore)。

📝 AssigneeのためのCheckList

  • OpenAIを利用したコードレビューボットの導入と設定
  • コードレビューボットのテストとフィードバックの反映
  • チームメンバーへのコードレビューボットの使用方法の教育

@yuminn-k yuminn-k added the ⚙ Setting 개발 환경 세팅 label Jan 24, 2024
@yuminn-k yuminn-k self-assigned this Jan 24, 2024
@Z00One Z00One merged commit 8bfc548 into main Jan 25, 2024
1 check passed
@yuminn-k yuminn-k deleted the openai-code-review branch January 25, 2024 11:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
⚙ Setting 개발 환경 세팅
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants